HELP - paramCmd
HelpCommand ReferenceparamCmd
Description  
Documenting parameters JavaDoc style( param )
Documenting parameters can be done in two ways, except template and macro parameters which currently can only be documented using the \param command. The "normal" way is demonstrated in fx. HowToDocument::Parameters and the other is using the on this page described \param command.
Syntax
\param <param_name> Parameter description ...

Example
\param iSize Parameter documentation for iSize

Output
See HowToDocument::ParametersJavaStyle for a good example.

About section commands
This command is a section command (also called "Special Sections"). Common to all section commands is the fact that the section continues until a blank line or another section command is encountered.

The section commands are:
See also
  • MACRO_PARAMETERS